/*
 * Copyright 2017-2019 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.health;

import io.micronaut.context.annotation.Requires;
import io.micronaut.context.env.Environment;
import io.micronaut.runtime.ApplicationConfiguration;
import io.micronaut.runtime.server.EmbeddedServer;

import java.lang.annotation.*;

/**
 * Annotation that expresses the requirements for enabling the heart beat.
 *
 * @author graemerocher
 * @since 1.1
 */
@Requires(property = ApplicationConfiguration.APPLICATION_NAME)
@Requires(condition = HeartbeatDiscoveryClientCondition.class)
@Requires(beans = EmbeddedServer.class)
@Requires(notEnv = {Environment.ANDROID, Environment.FUNCTION})
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PACKAGE, ElementType.TYPE, ElementType.ANNOTATION_TYPE, ElementType.METHOD})
public @interface HeartbeatEnabled {
}
